HMActionSet# PRO

HMActionSet is a HomeKit scene — a named bundle of characteristic write actions executed atomically.

There are two kinds:

• User-defined scenes you create via home.addUserActionSet(name), then populate with addCharacteristicAction(...).
• System scenes (wakeUp, sleep, homeArrival, homeDeparture) that Apple maintains automatically. You can read them via home.builtinActionSets() and execute them, but not modify their actions.

#Properties

#Building a scene

const movie = await home.addUserActionSet("Movie Time")

const lampPower = livingRoomLight.services
  .find(s => s.serviceType === 'lightbulb')!
  .characteristics.find(c => c.characteristicType === 'powerState')!

await movie.addCharacteristicAction(lampPower, false)

await home.executeActionSet(movie)

Remove individual actions with removeCharacteristicAction(characteristic), or remove the whole scene with home.removeActionSet(movie).